feat(catalog): add column description support#1260
Open
tychtjan wants to merge 2 commits intogooddata:masterfrom
Open
feat(catalog): add column description support#1260tychtjan wants to merge 2 commits intogooddata:masterfrom
tychtjan wants to merge 2 commits intogooddata:masterfrom
Conversation
added 2 commits
December 17, 2025 11:58
Add optional description field to SqlColumn and CatalogDeclarativeColumn to support database column comments. This enables passing column descriptions from scanModel API to LDM generation. risk: low jira: DX-312
Add comprehensive tests for SqlColumn and CatalogDeclarativeColumn description field including: - Creation with/without description - API conversion (to_api/from_api) - Equality comparison - Integration with CatalogPdmSql risk: nonprod jira: DX-312
tychtjan
requested review from
hkad98,
jaceksan,
lupko and
pcerny
as code owners
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add optional
descriptionfield toSqlColumnandCatalogDeclarativeColumnto support database column comments. This enables passing column descriptions from the scanModel API to LDM generation.When databases like Snowflake have column comments defined (e.g.,
COMMENT ON COLUMN table.column IS 'description'), these are now captured during scanning and can be used as descriptions for facts, attributes, labels in the generated LDM.Changes
description: Optional[str] = Nonefield toSqlColumnclassdescription: Optional[str] = Nonefield toCatalogDeclarativeColumnclassTesting
make formatpassesRisk Assessment
Related
Checklist